// 
// AsyncTask.cs
//  
// Author:
//       Tomas Vondracek <tomas.vondracek@gmail.com>
// 
// Copyright (c) 2009 Tomas Vondracek
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;

namespace ZVI.Threading
{	
	/// <summary>
	/// delegate work gui backround work
	/// this delegate is called in background thread in <see cref="GuiThreadDispetcher"/>
	/// </summary>
	public delegate void WorkCallback();	
	
	public delegate void TaskFinishedHandler(EventArgs e, AsyncTask task);

	/// <summary>
	/// basic class for background or computing tasks
	/// it is used in connection with delegates - <see cref=" GuiTask"/>
	/// and also as individual computing class <see cref="HsvEqualizationTask"/>
	/// </summary>
	public abstract class AsyncTask : IDisposable
	{					
		protected string description;
		
		public event TaskFinishedHandler OnFinished;
		
		public string Description {
			get {
				return description;
			}
		}
		
		public AsyncTask ()
		{
		}

		public AsyncTask (string description)
		{
			this.description = description;
		}
		
		
		public abstract void Run();
		
		public override string ToString ()
		{
			return string.Format ("[ThreadWorkItem: description={0}]", description);
		}
		
		#region IDisposable implementation
		public virtual void Dispose ()
		{
			
		}
		
		#endregion
	}
}
